Probo Reseller API icon

Probo Reseller API

1.2.x
(0 reviews)

Order status callback

The /order endpoint provides a callback to the url specified when placing the order.

When an order is queued including the callback url(s) in the /order payload:

"callback_urls": [
        "https://my.callback.url"
    ]

, the response payload on POST /order will be like (example):

{
  "status": "queued",
  "message": "Order queued",
  "order": {
    "id": "my_weborder_1234",
    "reference": "Banner 510 for customer X"
  }
}

When the order is accepted, the callback to the provided callback url includes the following payload (example):

{
  "status": "accepted",
  "message": "Order accepted",
  "order": {
    "id": "my_weborder_1234",
    "supplier_order_number": 202012345,
    "reference": "Banner 510 for customer X"
  }
}

When the order is not accepted, due to already existing order with same id the callback to the provided callback url includes the following payload (example):

{
  "status": "not_accepted",
  "message": "Order not accepted, reason: | Order with customer order id 'my_weborder_1234' for customer '9999' already exist",
  "order": {
    "id": "my_weborder_1234",
    "reference": "Banner 610 for customer X"
  }
}

customer '9999' indicates the customer id.

When the order is not accepted, due to a file error the callback to the provided callback url includes the following payload (example):

{
  "status": "not_accepted",
  "message": "File rejected, could not be processed",
  "file": {
    "id": 1
  },
  "order": {
    "id": "my_weborder_1234",
    "reference": "Banner 610 for customer X"
  }
}

When the order has been received (after "queued" and before "accepted"), the files still have to be downloaded and preflighted. When an error occurs in downloading or preflighting a callback will be made to the specified endpoint. A common cause of a preflighting error is a missing or not-allowed spot-color in the file.

Reviews